Add `Response.json` static method #1392

lucacasonato · 2022-01-30T17:58:44Z

This commit adds a Response.json static method that can be used to
create well formed JSON responses will very little effort.

The JSON response is not pretty printed.

Closes #1389

At least two implementers are interested (and none opposed):
- Chrome
- Firefox
- Deno
- Cloudflare Workers
Tests are written and can be reviewed and commented upon at:
- Fetch: add tests for Response.json web-platform-tests/wpt#32825
Implementation bugs are filed:
- Chrome: https://crbug.com/1305358
- Firefox: https://bugzilla.mozilla.org/show_bug.cgi?id=1758943
- Safari: https://bugs.webkit.org/show_bug.cgi?id=240375
- Deno: Implement Response.json() denoland/deno#13902

Preview | Diff

This commit adds a `Response.json` static method that can be used to create well formed JSON responses will very little effort.

fetch.bs

domenic · 2022-01-31T16:07:05Z

Note that we'd need to fix Web IDL first to allow regular and static operations with the same name:

The identifier of a static operation also must not be the same as the identifier of a regular operation defined on the same interface.

from https://webidl.spec.whatwg.org/#idl-operations

lucacasonato · 2022-02-01T13:47:47Z

@domenic Do you think that is desirable to change? It may be confusing to have both a prototype and static method with the same name. Maybe this method should be called fromJSON.

domenic · 2022-02-01T17:16:43Z

I think it is desirable to change and do not see anything confusing about having such methods, personally.

annevk

This looks reasonable, but I think it can be improved by making initialize a response also take a body and Content-Type header value (potentially as a tuple?). That would allow for sharing even more steps.

I also wonder what we should do here if browser interest isn't forthcoming. Perhaps there's a way in which we can still have mutual agreement, but it's not exposed in browsers for now. Perhaps this is worth bringing up in the HTML triage call (if it doesn't otherwise get resolved).

jasnell · 2022-03-08T16:08:59Z

Just fyi... I have an implementation of this in Cloudflare Workers just waiting on this to land or at least signal that it's moving forward.

domenic · 2022-03-08T16:13:57Z

I don't think we have any signal that this is moving forward in browsers, unfortunately, due to it just being low-priority sugar for browser teams. As such I don't think it'll land in Fetch, at least until a couple of browsers have engineers looking for starter projects.

I'd really encourage you to use this as a case study for https://github.com/whatwg/js-hosts . Figure out what sort of documentation you want to create there, which would enable you to land such things with confidence, and go for it! I'm happy to participate and secure guarantees like "Chromium will never ship a Response.json() with different semantics than those specified here".

lucacasonato · 2022-03-08T16:16:34Z

@domenic Would this get a 👍 from Chromium if we did the implementation work?

domenic · 2022-03-08T16:18:09Z

@ricea would be the decider there but I can predict with very high probability he would support it :).

fetch.bs

annevk

Mostly nits and request for a follow-up. Shared algorithm looks rather good! Thanks.

fetch.bs

Context: whatwg/fetch#1392.

foolip · 2022-05-23T07:14:44Z

This change isn't possible to roll into WPT's idlharness.js test, see web-platform-tests/wpt#34155. Does anyone want to give it a go to update idlharness.js to avoid this problem?

…stonly Automatic update from web-platform-tests Fetch: add tests for Response.json Context: whatwg/fetch#1392. -- wpt-commits: 27e770bcfbeae534b5d4cbc0a50d2b8247942312 wpt-pr: 32825

This commit adds support for the `Response.json` static method as specified in whatwg/fetch#1392. All WPTs from web-platform-tests/wpt#32825 pass. Bug: 1305358 Change-Id: Iaafdd514ed12644b6433c02e7d076ce43f51b9ef Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3639064 Reviewed-by: Yutaka Hirano <yhirano@chromium.org> Reviewed-by: Adam Rice <ricea@chromium.org> Commit-Queue: Yutaka Hirano <yhirano@chromium.org> Cr-Commit-Position: refs/heads/main@{#1019479}

This commit adds support for the `Response.json` static method as specified in whatwg/fetch#1392. All WPTs from web-platform-tests/wpt#32825 pass. Bug: 1305358 Change-Id: Iaafdd514ed12644b6433c02e7d076ce43f51b9ef Reviewed-on: https://chromium-review.googlesource.com/c/chromium/src/+/3639064 Reviewed-by: Yutaka Hirano <yhirano@chromium.org> Reviewed-by: Adam Rice <ricea@chromium.org> Commit-Queue: Yutaka Hirano <yhirano@chromium.org> Cr-Commit-Position: refs/heads/main@{#1019479} NOKEYCHECK=True GitOrigin-RevId: e680cd1bf0f99e44102f8714dcb5f77fba82c5ed

https://bugs.webkit.org/show_bug.cgi?id=240375 Reviewed by Youenn Fablet. This implements the `Response.json` static method, added to the fetch spec in whatwg/fetch#1392. * LayoutTests/imported/w3c/web-platform-tests/fetch/api/response/response-static-json.any-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/fetch/api/response/response-static-json.any.serviceworker-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/fetch/api/response/response-static-json.any.sharedworker-expected.txt: * LayoutTests/imported/w3c/web-platform-tests/fetch/api/response/response-static-json.any.worker-expected.txt: * Source/WebCore/Modules/fetch/FetchBody.h: * Source/WebCore/Modules/fetch/FetchResponse.cpp: (WebCore::FetchResponse::create): Added this method overload to implement the spec's "initialize a response" algorithm. This algortihm used to be combined with the regular Response creation algorithm which extracts the body, but Response.json cannot use that directly. (WebCore::FetchResponse::staticJson): * Source/WebCore/Modules/fetch/FetchResponse.h: * Source/WebCore/Modules/fetch/FetchResponse.idl: Canonical link: https://commits.webkit.org/261960@main

Add Response.json static method

726281b

This commit adds a `Response.json` static method that can be used to create well formed JSON responses will very little effort.

lucacasonato commented Jan 30, 2022

View reviewed changes

fetch.bs Show resolved Hide resolved

andreubotella reviewed Jan 30, 2022

View reviewed changes

fetch.bs Outdated Show resolved Hide resolved

use -> JSON bytes algorithm

77ac97f

Split out common steps into a separate algorithm

b026a33

lucacasonato requested a review from annevk February 11, 2022 22:53

lucacasonato mentioned this pull request Feb 11, 2022

Fetch: add tests for Response.json web-platform-tests/wpt#32825

Merged

annevk reviewed Feb 14, 2022

View reviewed changes

domenic mentioned this pull request Feb 14, 2022

Add import.meta.resolve() whatwg/html#5572

Merged

3 tasks

lucacasonato added 3 commits March 9, 2022 00:10

move init steps into "initialize a response"

1c2fa91

fix

a0050fa

Merge remote-tracking branch 'origin/main' into response_json_method

a903085

yutakahirano reviewed Mar 9, 2022

View reviewed changes

fetch.bs Show resolved Hide resolved

lucacasonato added 3 commits March 9, 2022 15:24

redeploy

9830a2a

redeploy

80a7a7c

redeploy

9d57739

lucacasonato requested a review from annevk March 9, 2022 18:07

annevk added the needs implementer interest Moving the issue forward requires implementers to express interest label Mar 10, 2022

annevk reviewed Mar 10, 2022

View reviewed changes

fetch.bs Outdated Show resolved Hide resolved

fetch.bs Outdated Show resolved Hide resolved

fetch.bs Show resolved Hide resolved

fetch.bs Outdated Show resolved Hide resolved

fetch.bs Show resolved Hide resolved

fetch.bs Show resolved Hide resolved

address review comments

391b817

lucacasonato mentioned this pull request Mar 10, 2022

Use "body with type" from #1392 throughout spec #1410

Closed

lucacasonato requested a review from annevk March 10, 2022 12:48

annevk approved these changes Mar 10, 2022

View reviewed changes

annevk pushed a commit to web-platform-tests/wpt that referenced this pull request May 18, 2022

Fetch: add tests for Response.json

27e770b

Context: whatwg/fetch#1392.

annevk added addition/proposal New features or enhancements topic: api labels May 18, 2022

annevk merged commit b3bfd0c into whatwg:main May 18, 2022

fabiancook mentioned this pull request May 18, 2022

Response.json + other helpers opennetwork/http-representation#6

Merged

foolip mentioned this pull request May 23, 2022

Sync interfaces/ with @webref/idl 3.12.4 web-platform-tests/wpt#34155

Merged

azu mentioned this pull request May 24, 2022

2022-05-24のJS: Deno 1.22、Storybook 6.5(webpack Lazy Compilation)、Next.js Layouts RFC jser/jser.github.io#988

Merged

annevk mentioned this pull request May 25, 2022

Response.json() mozilla/standards-positions#640

Closed

KianNH mentioned this pull request May 26, 2022

[Workers] Add Response.json() method to API docs cloudflare/cloudflare-docs#4594

Merged

Cherry mentioned this pull request May 27, 2022

Add support for static Response.json method cloudflare/miniflare#272

Closed

wbamberg mentioned this pull request Jun 2, 2022

Add Web/API page types, part 19 mdn/content#16878

Merged

cyco130 mentioned this pull request Jun 23, 2022

Response.json static method hattipjs/hattip#12

Closed

lucacasonato mentioned this pull request Sep 13, 2022

bug(fetch): Response.json should set charset type in content type header denoland/deno#15884

Closed

mcansh mentioned this pull request Oct 14, 2022

feat: add Response.json static method remix-run/web-std-io#10

Open

KhafraDev mentioned this pull request Nov 8, 2022

feat: add static Response.json node-fetch/node-fetch#1670

Merged

2 tasks

regseb mentioned this pull request Nov 11, 2022

Rule proposal: prefer-static-response-json instead of new Response(JSON.stringify()) sindresorhus/eslint-plugin-unicorn#1960

Open

regseb mentioned this pull request Dec 7, 2022

Add method static Response.json(data, init) microsoft/TypeScript-DOM-lib-generator#1444

Closed

andreubotella mentioned this pull request Feb 23, 2023

[fetch] Implement the Response.json static method WebKit/WebKit#10593

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add `Response.json` static method #1392

Add `Response.json` static method #1392

lucacasonato commented Jan 30, 2022 •

edited by pr-preview bot

Loading

domenic commented Jan 31, 2022

lucacasonato commented Feb 1, 2022

domenic commented Feb 1, 2022

annevk left a comment

jasnell commented Mar 8, 2022

domenic commented Mar 8, 2022 •

edited

Loading

lucacasonato commented Mar 8, 2022

domenic commented Mar 8, 2022

annevk left a comment

foolip commented May 23, 2022

Add Response.json static method #1392

Add Response.json static method #1392

Conversation

lucacasonato commented Jan 30, 2022 • edited by pr-preview bot Loading

domenic commented Jan 31, 2022

lucacasonato commented Feb 1, 2022

domenic commented Feb 1, 2022

annevk left a comment

Choose a reason for hiding this comment

jasnell commented Mar 8, 2022

domenic commented Mar 8, 2022 • edited Loading

lucacasonato commented Mar 8, 2022

domenic commented Mar 8, 2022

annevk left a comment

Choose a reason for hiding this comment

foolip commented May 23, 2022

Add `Response.json` static method #1392

Add `Response.json` static method #1392

lucacasonato commented Jan 30, 2022 •

edited by pr-preview bot

Loading

domenic commented Mar 8, 2022 •

edited

Loading